home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 5 / MacMania 5.toast / / Tools&Utilities / Step Across 1.20 / Step Across Manual E < prev   
Text File  |  1995-03-01  |  13KB  |  352 lines

  1. (This text looks good in Monaco or Courier 9pt, esp. for the list closing it.)
  2.  
  3.  
  4.  
  5. Some early words:
  6.  
  7. - "Step Across" is freeware. 
  8. - You are using this software at your own risk.
  9. - It was written and it’s copyrighted by 
  10.   Michael Ahrweiler in Hamburg, Germany.
  11.  
  12.   If you do run into things, that do not behave as they should, 
  13.   you can reach me on the Internet: Michael_Ahrweiler@hh2.maus.de
  14.  
  15. That’s all for the early times. 
  16. Make yourself at home, here comes the doc.
  17. Michael Ahrweiler
  18.  
  19.  
  20.  
  21.  
  22.  
  23. THE STEP ACROSS MANUAL FILES
  24. ----------------------------
  25.  
  26. Step Across converts ASCII-text between the systems:
  27. DOS, OS2, Windows, Unix, Atari, Amiga and Macintosh (& vice versa).
  28.  
  29.  
  30.  
  31. QUICK OUTLINE
  32. -------------
  33.  
  34. Using Step Across after starting it with the a doubleclick:
  35.  
  36. - Starting Step Across by doubleclick allows you to select and to convert 
  37.   one text after the other while dragdrop will do as much as you can drag
  38.   in one hit.
  39.  
  40. - You should first go to the OPTIONS-menu to select the "opponent" operating 
  41.   system, to/from which you want to convert.
  42.   You will find the appropriate popup menu the configuration dialog selecting
  43.   the menu entry "options->CONFIGURATION".
  44.  
  45. - There are some more things you can set in this dialog, like selecting TYPE 
  46.   and CREATOR of the target file. Maybe you want to give the converted file a 
  47.   brandnew name or maybe you rely on the automatism, which adds an extension.
  48.   You decide here which character will replace those which are not 
  49.   convertible, or if some unwrapping and typographic conversion should be done 
  50.   on the text etc etc.
  51.   Just take a look at the configuration-dialog and set, what you prefer.
  52.   All of those details will follow below.
  53.  
  54. - The name of the opponent system will appear in brackets in the menu-bar. 
  55.   Additionally the "To Other" entry in the file-menu will be renamed to
  56.   the selected system (like: "To Windows").
  57.  
  58. - The conversion is started by selecting the desired direction from the FILE-menu.
  59.   The open dialog will come up to select a file to be converted.
  60.  
  61. - While converting Step Across will display a status box with a progress bar.
  62.   You can cancel the conversion by pressing "command-period" or by clicking
  63.   the "Cancel"-Button.
  64.  
  65. - If you have selected so, the save dialog will ask you for a name for
  66.   the converted text-file.
  67.  
  68. - Whenever you leave the program all actual settings will be saved.
  69.   (There will be a message on the first launch, when no pref-file is found,
  70.    and the default values will be set).
  71.  
  72.  
  73. The very same thing in DRAGDROP-mode:
  74.  
  75. - After having once set your basic configuration, you might find it much more
  76.   comfortable to launch Step Across by dragging the item(s) you want to convert
  77.   on its icon.
  78.  
  79. - You may drag as many selected items on the Step Across icon, as you want to.
  80.   Yet, Step Across will not open or look inside of folders.
  81.   The converted files will be put into the same folder, as the originals,
  82.   and will be written over the original files, if you don’t change their names
  83.   (by hand or by letting Step Across add an extension).
  84.  
  85. - In dragdrop-mode the default direction for the conversion is: to Mac!
  86.   You can switch it to "To Other", by holding the OPTION key down, while you
  87.   drag the item(s) to the Step Across icon.
  88.  
  89. - If you are in doubt about your actual configuration, you can force the
  90.   config-dialog to come up before conversion by holding down the COMMAND key.
  91.   (You can hold down both "option" and "command" to convert "To Other" after 
  92.    checking/changing your configuration.)
  93.  
  94. - In case, you dragged more than one item on the Step Across icon, 
  95.   hitting "command/period" will ask if you want to cancel the conversion of the 
  96.   actual file (as named above the status bar) or the entire process.
  97.  
  98. - If Step Across was already running when you dragged items, it will not terminate
  99.   after the conversion, (as a dragdrop-utility should) but waits for more files.
  100.  
  101.  
  102.  
  103.  
  104. CONFIGURATION 1 (File Management)
  105. ---------------------------------
  106.  
  107. What choices do I have for the target files:
  108.  
  109. - TYPE and CREATOR can be set (or will be left unchanged).
  110.  
  111. - You can be add an extension after your choice to the original file name,
  112.   to save the result in a different file. The extension can be different,
  113.   depending the direction of the conversion.
  114.  
  115. - Also you the target file can be renamed manually, if you do want to give 
  116.   it a new, more descriptiv (longer) file name.
  117.  
  118.   If you have selected both options, then the save dialog will come up after
  119.   each conversion defaulted with the original file name plus the extension.
  120.  
  121.   If you have selected neither of both options, the original files will be
  122.   overwritten WITHOUT NOTICE!!!
  123.  
  124.   This "low garbage-high danger" mode will not work, if the file in question is
  125.   larger than the available memory. Step Across will then ask for different file
  126.   name (and will not let you go on until you enter some).
  127.  
  128.   BTW: If you have selected at least one of the renaming options, you will be
  129.        noted, if an existing file is to be overwritten.
  130.  
  131.  
  132.  
  133.  
  134. CONFIGURATION 2 (Conversion)
  135. ----------------------------
  136.  
  137. Memory handling:
  138.   There is no limit in size for the files you convert with Step Across.
  139.   If you want to deal a mega ton-file, the program will do it in slices
  140.   fitting into the available memory. You can upsize the slices by giving
  141.   Step Across more than the original 384k in the INFO-dialog in the finder.
  142.   It might speed the conversion of large files, but it’s not necessary.
  143.  
  144.  
  145. Mac’s own and the other CHARACTERSETS:
  146.  
  147. - Selecting "DOS" or "codepage 437" will convert the text into the german 
  148.   codepage of those good old dosaenian ages (kind a like a german program).
  149.   Codepage 437 holds some (german) Umlauts and a lot of this kinky line drawing
  150.   letters, they use to do boxes on dos screens.
  151.   Don’t expect ANYTHING like quotes, dashes etc.
  152.  
  153.   (That’s why Step Across does some "similar"-conversion.
  154.    Read more about this below...)
  155.  
  156. - "OS2" or "codepage 850" resp. is very much the same as DOS.
  157.   The characterset holds a certain number of (lowercase) international letters 
  158.   (esp. french ones), though - and very few uppercase things.
  159.   Don’t expect anything like quotes, dashes etc.
  160.  
  161. - Windows, Unix and the Amiga system use very much the same thing, which is 
  162.   standarized as "ISO 8859-I". This ISO-thing again looks very much like the
  163.   codepage 850 (only it holds its letters in other places).
  164.   So: Don’t expect anything like quotes, dashes etc.
  165.   You might be interested to hear that Unix often only does 128 ASCII characters,
  166.   which means: no chance for no special characters at no time at all.
  167.  
  168.   Windows does some more stuff between 128 and 160 and actually they doing 
  169.   a very good thing there. Text can be converted between Mac and Windows with
  170.   almost no losses of any kind. 
  171.   So: DO EXPECT quotes, dashes, ... everything.
  172.  
  173. - Atari offers two characters sets. The "TOS"-thing looks much like codepage 850.
  174.   The Speedo thing has quite a few characters to offer.
  175.   So: Do expect quotes, dashes, ... and almost everything.
  176.  
  177.  
  178. There is a little word to do about WORD and Windows ASCII:
  179.  
  180. When I said "Windows" above, I was talking about Windows ASCII.
  181. You will have it imported into the simple "notepad" or MS-Write, as well
  182. as into AmiPro and-for instance-the Windows version of Quark Xpress.
  183. But DO NOT EXPECT MS-Word "for Windows" to zipp your text in as Windows ASCII. 
  184. Those doseanian roots, where WORD is still captured in, will cause the software 
  185. to import ASCII as "DOS-text" with the limits of codepage 850 
  186. (sometimes depending on the setting that was done on the default printer,
  187.  like codepage 437 or... But why not, oh man...?)
  188.  
  189.  
  190.  
  191.  
  192. The FEATURES of the CONVERSION ENGINE
  193. -------------------------------------
  194.  
  195. Whatever the engine does, it will not leave a single character aside, 
  196. that has a counterpart in the target set of characters.
  197. Line feeds will be converted to the appropriate type.
  198.  
  199. (You expected this, didn’t you? Ok, this only was the intro for...)
  200.  
  201.  
  202. >>Replacement character and "similar" conversion
  203.  
  204. When a character has no equivalent in the target characterset, there are 
  205. several possibilities what will happen:
  206.  
  207. - "Non convertible characters" will be set to a replacement character,
  208.   which you can set in the configuration dialog.
  209.  
  210. - But also something else might happen, sounds like this:
  211.   If you do select the "replace missing with similar"-option,
  212.   Step Across will do some work to reproduce the missing character by
  213.   others (and sometimes more than one), to maintain at least the original 
  214.   "meaning" of the text.
  215.   The lists at the very bottom of this text tell you exactly, what’s
  216.   going down, if you enable "similar" conversions.
  217.  
  218.  
  219. >>Unwrapping and typographic conversion
  220.  
  221. If you are converting text to the Mac, you might find it pretty stupid to
  222. encounter text in which every line will form a seperate paragraph. 
  223.  
  224. That’s why Step Across does some "unwrapping" for you. 
  225. As known from editors like "Edit" or "BBEdit", the result of unwrapping is 
  226. not always that desirable... especially if it’s done across an entire text.
  227. There are circumstances where a line feed and a paragraph ending can simply 
  228. not be distinguished from one another.
  229.  
  230. The "unwrapping" machine in Step Across is pretty smart though (hhm!).
  231.  
  232. In addition, not to spoil text, which is already unwrapped, 
  233. it does some checking before action: 
  234. A text that looks unwrapped will not be re-unwrapped, 
  235. even if the option to do so is set. 
  236.  
  237.  
  238. The "typographic" part of this option will do some more conversion
  239. for readable (well, lets say: "fashionable") input to the Mac:
  240.  
  241. - "Hard" hyphens will be removed from the text.
  242. - Double, triple etc. spaces will be replaced by a single space.
  243.  
  244. - Typewriter quotes (Shift-2) will be converted to typographic ones.
  245. - Double commas or apostrophs (ASCII 39 bzw. 96) are replaced by
  246.   the appropriate typographic quotes.
  247.  
  248. - Double hyphens will be switched to an em-dash.
  249. - Triple periods will be converted to an ellipsis.
  250.  
  251. This should beware of the most usual mishabits on codepage 850 etc.
  252.  
  253.  
  254. >>What is "missing to similar"?
  255.  
  256. More or less consequent Step Across will do exactly these replacements
  257. (mentioned just above) to maintain the text’s integrity, if you convert 
  258. a text to a system, that does not support quotes etc., if you activate 
  259. "missing to similar".
  260.  
  261. These are some examples of what will happen in these cases:
  262.  1) Accent characters will simply be replaced by the ones without accent.
  263.  2) The "one half" character will turn into the three letters: "1/2".
  264.  3) Double quotes become double commas, apostrophs and so.
  265.  See lists on end of text for exact replacements.
  266.  
  267.  
  268.  
  269. Yet there are some SPECIAL CONVERSIONS waiting for you:
  270.  
  271. They do so in a dialog yet unmentioned called "special conversions",
  272. which you will find in the options menu.
  273. (This dialog cannot be reached or changed in dragdrop-mode.)
  274.  
  275. The special conversions allow you to react to those special things people
  276. have done on systems without legal access to quotes etc. You might encounter
  277. some real tricky special solutions for getting quotes etc. on dos machines.
  278. Some of these have for instance helped themselves to obtain 
  279. the quotes right off the postscript printer by switching here and there...
  280.  
  281. So. In this dialog you can enter characters to be converted to quotes
  282. or emdashes on the Mac.
  283. In addition to this you get three absolutely free conversions:
  284. Enter the character you want to hook - and the one it should turn into.
  285.  
  286. The special conversions can be selected one by one in their dialog,
  287. whatever is set in the special conversions dialog can then be globally 
  288. activated or paralysed from the configuration dialog.
  289.  
  290.  
  291.  
  292. Well, that should be it ... 
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299. except the "similar conversions" lists:
  300.  
  301.  
  302. In direction "to the Mac":
  303.  
  304. From DOS, Atari-TOS, Unix, Amiga:
  305. The one-half, one-quarter, power-two, power-three signs will be written out
  306. as characters "1/2" etc., "power-two" will turn into "^2".
  307.  
  308. From Windows:
  309. As "from DOS" plus (’cause they have some eastern european stuff)
  310. - S-caron       => S, 
  311. - s-caron       => s, 
  312. - y-acute       => y, 
  313. - Y-acute       => Y,
  314. - D-stroke      => D.
  315.  
  316. From OS2:
  317. As "from DOS" plus
  318. - D-stroke      => D, 
  319. - y-acute       => y, 
  320. - Y-acute       => Y.
  321.  
  322.  
  323. Converting "to Other":
  324.  
  325. To DOS and Atari-TOS:
  326. - ellipsis      => "..." (triple period)
  327. - ndash, mdash  => "--"  (double hyphen)
  328. - quotes        => double commas, apostrophs etc. depending on which quotes.
  329. - fi-ligatur    => "fi"
  330. - fl-ligatur    => "fl"
  331. - dbldagger     => dagger
  332. - perthousand   => "0/00"
  333. - quite a few uppercase accent characters will become the simple uppercase ones.
  334.  
  335.  
  336. To Unix, Amiga, OS2:
  337. As "to DOS" plus
  338. - Œ, œ          => "OE", "oe"
  339. - ≤, ≥          => "<=", "=>"
  340.  
  341.  
  342. To Windows:
  343. (not much on the do-list there)
  344. - fi-ligatur    => "fi"
  345. - fl-ligatur    => "fl"
  346. - pointless i   => "i"
  347. - ≤, ≥          => "<=", "=>"
  348.  
  349.  
  350. Now, this IS it.
  351.  
  352.